Skip to main content
POST
/
public
/
v1
/
campaign-service
/
campaigns
/
exclusive-banner
[BETA] Create exclusive banner campaign.
curl --request POST \
  --url https://api.topsort.com/public/v1/campaign-service/campaigns/exclusive-banner \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "bids": [
    {
      "amount": 1,
      "formatProperties": {
        "adFormat": "banner",
        "bannerAssets": [
          {
            "assetId": "asset_01j713j64yfsvtj4bs3ccpy5ca",
            "content": {},
            "contentType": "image/png",
            "dimensions": {
              "height": 1080,
              "width": 1920
            },
            "jsonTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "size": 123,
            "url": "<string>"
          }
        ],
        "deviceType": "desktop",
        "slotId": "<string>"
      },
      "location": "Santiago",
      "target": {
        "id": "p_8983",
        "type": "product"
      },
      "trigger": {
        "type": "keyword",
        "value": {
          "matchType": "exact",
          "words": [
            "<string>"
          ]
        }
      },
      "triggers": []
    }
  ],
  "endDate": "2023-11-07T05:31:56Z",
  "exclusivityPercentage": 123,
  "exclusivityPrice": 123,
  "externalCampaignId": "<string>",
  "impressionsThreshold": 123,
  "isActive": true,
  "isAutoTrigger": false,
  "name": "Bola-Bola Ad campaign",
  "productIds": [
    "<string>"
  ],
  "startDate": "2023-11-07T05:31:56Z",
  "status": "pending",
  "walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}'
{
  "adFormat": "exclusive_banner",
  "bidType": "exclusive",
  "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "campaignType": "manual",
  "chargeType": "DAILY",
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "endDate": "2023-11-07T05:31:56Z",
  "exclusivityPercentage": 123,
  "exclusivityPrice": 123,
  "externalCampaignId": "<string>",
  "impressionsThreshold": 123,
  "isActive": true,
  "isAutoTrigger": false,
  "marketplaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "Bola-Bola Ad campaign",
  "startDate": "2023-11-07T05:31:56Z",
  "status": "pending",
  "vendorId": "<string>",
  "walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

A valid API key generated in Topsort's UI.

Query Parameters

​
vendor_id
string
required

The ID of the vendor.

Minimum length: 1

Body

application/json

The request body for creating an exclusive banner campaign.

​
bids
BidCreate · object[]
required

An array of bids for this campaign.

Minimum length: 1
​
endDate
string<date-time>
required

When should the campaign stop. Must be greater than start date.

​
exclusivityPrice
integer
required

The price to pay daily for the campaign to run.

​
name
string
required

The name of the campaign.

Minimum length: 1
Example:

"Bola-Bola Ad campaign"

​
startDate
string<date-time>
required

When should the campaign start. If the start date is in the past, it will be set to the current date.

​
exclusivityPercentage
number

Percentage of auctions the campaign will be exclusive in.

​
externalCampaignId
string

The external ID of the campaign in the marketplace. Must be unique per marketplace and format combination.

​
impressionsThreshold
integer

Impressions allowed for the campaign before it is stopped.

​
isActive
boolean
default:true

Whether the campaign should be activated upon creation.The campaign will start when this is set and the start_date has passed.

​
isAutoTrigger
boolean
default:false

Whether the campaign is auto-triggered.

​
productIds
string[]

The product IDs to be used in the exclusive banner campaign. When provided, the assets will be associated to the given product IDs.

Maximum length: 200
​
status
enum<string>

For an exclusive banner campaign, its initial review status.

Available options:
approved,
pending,
rejected
​
walletId
string<uuid>

The uuid of the wallet to be used with this campaign.

Response

Successful Response

Model that represents an Exclusive Banner Campaign.

​
adFormat
enum<string>
required

The ad format of the campaign. Can be exclusive_banner.

Available options:
exclusive_banner
Example:

"exclusive_banner"

​
campaignId
string<uuid>
required

The ID of the campaign.

​
campaignType
enum<string>
required

The bidding method for the campaign.

Available options:
manual,
autobidding,
exclusive
​
chargeType
enum<string>
required

How exclusive campaigns are going to be charged, only daily is allowed.

Available options:
DAILY
​
exclusivityPrice
integer
required

The price to pay daily for the campaign to run.

​
marketplaceId
string<uuid>
required

The ID of the marketplace.

​
name
string
required

The name of the campaign.

Minimum length: 1
Example:

"Bola-Bola Ad campaign"

​
vendorId
string
required

The marketplace's ID of the vendor.

​
walletId
string<uuid>
required

The uuid of the wallet to be used with this campaign.

​
bidType
enum<string>
default:exclusive

The bidding type of the campaign.

Available options:
exclusive
​
createdBy
string<uuid>

The ID of the user creating the campaign.

​
endDate
string<date-time>

Date when to stop the campaign, specified in RFC 3339, if not set the campaign will never stop. This date must be greater than the start date and must be in the future. Must include the Timezone definition.

​
exclusivityPercentage
number

Percentage of auctions the campaign will be exclusive in.

​
externalCampaignId
string

The external ID of the campaign in the marketplace.

​
impressionsThreshold
integer

Impressions allowed for the campaign before it is stopped.

​
isActive
boolean
default:true

Whether the campaign should be activated upon creation.The campaign will start when this is set and the start_date has passed.

​
isAutoTrigger
boolean
default:false

Whether the campaign is auto-triggered.

​
startDate
string<date-time>

Date when to start the campaign, specified in RFC 3339, if not set that campaign will start immediately after the campaign creation. Must include the Timezone definition.If the start date is in the past, it will be set to the current date.

​
status
enum<string>

For an exclusive banner campaign, its initial review status.

Available options:
approved,
pending,
rejected
⌘I